Sequence Sidekick provides a fully equipped backend, leveraging Sequence’s infrastructure to read and write to the blockchain through a simple API.
BACKEND_WALLET_PV_KEY
or AWS / GCP KMS
signer you provide, this allows gas-sponsorship, batching and other optimizations.
To configure the backend wallet, you can:
dev.key
file.ECC_NIST_P256_KEY_ALIAS
GCP_KEY_RING_NAME
Clone the Sidekick repository
Setup the required environment variables
Variable | Description |
---|---|
PROJECT_ACCESS_KEY | Access key from Sequence Builder API Keys |
Variable | Description |
---|---|
BACKEND_WALLET_PV_KEY | Private key for the EOA used to sign transactions |
PORT | Port for the Sidekick server (default: 7500) |
HOST | Host address for the server (default: 0.0.0.0) |
REDIS_HOST | Redis server host (default: localhost) |
REDIS_PORT | Redis server port (default: 6379) |
REDIS_PASSWORD | Password for Redis server (optional) |
DATABASE_URL | PostgreSQL connection string for Sidekick database |
SIDEKICK_API_SECRET_KEY | Secret key required for write access to the Sidekick API |
ETHERSCAN_API_KEY | API key for Etherscan to enable contract verification |
VERIFY_CONTRACT_ON_DEPLOY | Enable automatic contract verification on deployment (set to true to enable) |
DEBUG | Enable debug logging (set to true for verbose output) |
SIGNER_TYPE | Type of signer to use (local, aws_kms, google_kms) |
AWS_REGION | AWS account region |
AWS_ACCESS_KEY_ID | AWS access key ID |
AWS_SECRET_ACCESS_KEY | AWS secret access key |
AWS_KMS_KEY_ID | ID of the KMS key to use |
PROJECT | GCP project name |
LOCATION | GCP project location |
KEY_RING | Key ring name |
CRYPTO_KEY | Crypto key name |
CRYPTO_KEY_VERSION | Crypto key version |
Variable | Description | |
---|---|---|
SIGNER_TYPE | local | |
BACKEND_WALLET_PV_KEY | 0x… | (optional) |
Variable | Description |
---|---|
SIGNER_TYPE | aws_kms |
AWS_REGION | AWS account region |
AWS_ACCESS_KEY_ID | AWS access key ID |
AWS_SECRET_ACCESS_KEY | AWS secret access key |
AWS_KMS_KEY_ID | ID of the KMS key to use |
Variable | Description |
---|---|
SIGNER_TYPE | google_kms |
PROJECT | GCP project name |
LOCATION | GCP project location |
KEY_RING | Key ring name |
CRYPTO_KEY | Crypto key name |
CRYPTO_KEY_VERSION | Crypto key version |
Make sure you have Docker installed
Start Sidekick in a Docker container
Check your backend wallet address